EfFieldFormatter

class EfFieldFormatter implements IteratorAggregate, Countable

Base class for Entity fields. Extend this class to implement custom field formatter.

Methods

__construct(EntityMetadataWrapper $property, bool $isMultivalue)

Constructor.

array|string
value()

Returns the current field item as a raw array.

array
values()

Returns all raw field items in an array.

EfFieldFormatter[]
all()

Returns an array of all field items as EfFieldFormatter objects.

array
setDelta($delta)

Set the current field delta.

bool
isDeltaValid(null $delta = NULL)

Checks if the given or current field delta exists.

bool
notEmpty()

Shortcut for the possible not so easy to understand isDeltaValid() method.

bool
isAccessible()

Check if current user is allowed to view this field.

EfFieldFormatterIterator
getIterator()

Implementing IteratorAggregate interface.

int
count()

Implementing Countable interface.

Details

at line 23
__construct(EntityMetadataWrapper $property, bool $isMultivalue)

Constructor.

Parameters

EntityMetadataWrapper $property The value of this field wrapped by an EntityMetadataWrapper.
bool $isMultivalue Whether this field has a cardinality greater than one.

at line 43
array|string value()

Returns the current field item as a raw array.

Return Value

array|string

at line 52
array values()

Returns all raw field items in an array.

Return Value

array

at line 61
EfFieldFormatter[] all()

Returns an array of all field items as EfFieldFormatter objects.

Return Value

EfFieldFormatter[]

at line 74
array setDelta($delta)

Set the current field delta.

Parameters

$delta

Return Value

array

at line 91
bool isDeltaValid(null $delta = NULL)

Checks if the given or current field delta exists.

Parameters

null $delta

Return Value

bool

at line 102
bool notEmpty()

Shortcut for the possible not so easy to understand isDeltaValid() method.

Return Value

bool

at line 113
bool isAccessible()

Check if current user is allowed to view this field.

Can be needed if a module like field_permissions is in use.

Return Value

bool True, if current user is allowed to view this field.

at line 124
EfFieldFormatterIterator getIterator()

Implementing IteratorAggregate interface.

If we wrap a list, we return an iterator over the data list.

Return Value

EfFieldFormatterIterator

at line 133
int count()

Implementing Countable interface.

Return Value

int The number of items of this field.